/*
 * Middleware
 * Copyright (C) 2010/11
 * Riccardo Pulvirenti, Giuseppe Ravidà, Andrea Tino
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANDABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see http://www.gnu.org/licenses
 */

/*!
 * File: wfqueue.hpp
 */

#ifndef _WFQUEUE_HPP_
#define _WFQUEUE_HPP_

#include "interface.hpp"
#include "workflow.hpp"

//-----------------------------------------------------------------------------
// Interface definitions
namespace middleware {
/*! \class WFQueue
 * \brief Interface to communicate to Manage in order to enqueue and dequeue
 * a Workflow.
 *
 * Interface for classes aiming to connect to a queue of Workflow and
 * performing operations on it.
 */
interface WFQueue {
public:
	/*!
	 * Enqueues a Workflow in the queue stored in Manager.
	 * \paran workflow Workflow to enqueue.
	 */
	virtual void enqueue(const Workflow& workflow) = 0;
	/*!
	 * Dequeues a Workflow from the queue of Workflow in Manager.
	 * \return Returns the dequeued Workflow.
	 */
	virtual Workflow dequeue() = 0;
};
} /* middleware */

#endif
